/*
**    Copyright (C) 2003-2011 Institute for Systems Biology
**                            Seattle, Washington, USA.
**
**    This library is free software; you can redistribute it and/or
**    modify it under the terms of the GNU Lesser General Public
**    License as published by the Free Software Foundation; either
**    version 3 of the License, or (at your option) any later version.
**
**    This library is distributed in the hope that it will be useful,
**    but WITHOUT ANY WARRANTY; without even the implied warranty of
**    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
**    Lesser General Public License for more details.
**
**    You should have received a copy of the GNU Lesser General Public
**    License along with this library; if not, write to the Free Software
**    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
*/

package org.systemsbiology.iteration;

import java.util.Iterator;

import org.systemsbiology.util.Filter;

/**
 * An adapter for an Iterable that filters out certain values from its iterator,
 * by wrapping its iterators in instances of FilteredIterator. Takes a Filter<T>
 * to decide what elements to include.
 * @author anorberg
 *
 * @param <T> Yield type of the underlying iterators.
 */
public class FilteredIterable<T> implements Iterable<T> {

	private Iterable<? extends T> backingIterable;
	private Filter<? super T> acceptor;
	
	public FilteredIterable(Iterable<? extends T> data, Filter<? super T> acceptor){
		this.backingIterable = data;
		this.acceptor = acceptor;
	}
	
	public Iterator<T> iterator() {
		return new FilteredIterator<T>(backingIterable.iterator(), acceptor);
	}

}
